Skip to content

Conversation

lucperkins
Copy link
Member

@lucperkins lucperkins commented Sep 17, 2025

Summary by CodeRabbit

  • Documentation
    • Added a “You can download the ISOs at these addresses” section with a table linking x86_64 and aarch64 ISOs.
    • Replaced a plain note with a Markdown admonition for clearer visibility.
    • Clarified installer image behavior: Flakes enabled by default and NetworkManager used instead of WPA Supplicant.
    • Expanded installed-tools list to document Determinate Nix (with determinate-nixd login) and the FlakeHub CLI (fh) with usage examples.

Copy link

coderabbitai bot commented Sep 17, 2025

Walkthrough

Updated README.md: added an ISO download table for x86_64 and aarch64, replaced a plain note with a Markdown admonition describing two installer-image differences (Flakes enabled via Determinate Nix; NetworkManager used), and expanded the installed-tools section to document Determinate Nix/determinate-nixd and the fh CLI with usage examples.

Changes

Cohort / File(s) Summary of Changes
Docs: README content and formatting
README.md
Added "You can download the ISOs" table (x86_64 Linux, aarch64 Linux). Replaced a plain note with a Markdown admonition describing two differences: Flakes enabled by default via Determinate Nix and NetworkManager enabled instead of bare wpa_supplicant. Expanded installed-tools section to document Determinate Nix and determinate-nixd login example, and added the fh CLI with an fh apply nixos usage example. No code, logic, or public API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I’m a rabbit in the README glen,
I hop to links and tidy them. 🐇
Flakes and login, tools align,
FH commands now clear and fine.
Small changes — docs that mend.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "FH-1031: Add ISO download URLs to README" accurately and concisely summarizes the primary change in this PR — adding ISO download URLs to the README — and matches the changes described in the provided summary. It is specific, readable, and includes the related ticket identifier without extraneous detail, so a reviewer scanning history will understand the main intent. The title is appropriately focused on documentation changes rather than unrelated files or vague wording.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch provide-iso-urls

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@lucperkins lucperkins changed the title Add ISO download URLs to README FH-1031: Add ISO download URLs to README Sep 17, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

38-39: Pluralize and tighten the NOTE; use upstream tool name casing.

Clarifies scope (both images), avoids “identical” ambiguity, and uses “wpa_supplicant”.

Apply this diff:

-> [!NOTE]
-> This NixOS installer image is identical to NixOS's ISOs, but with flakes enabled by default via Determinate Nix and NetworkManager enabled instead of bare WPA Supplicant.
+> [!NOTE]
+> These installer images are functionally identical to the upstream NixOS ISOs, with two differences:
+> - flakes are enabled by default via Determinate Nix
+> - NetworkManager is enabled instead of wpa_supplicant
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b281254 and f2367ad.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

15-15: Bare URL used

(MD034, no-bare-urls)


16-16: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build (UbuntuLatest32Cores128G, x86_64-linux)
  • GitHub Check: build (UbuntuLatest32Cores128GArm, aarch64-linux)
🔇 Additional comments (1)
README.md (1)

11-17: Replace bare URLs with Markdown links (fixes MD034) — add reference-style defs and verify redirects.

Quick check: both URLs returned HTTP 307 (temporary redirect) — follow redirects (curl -L) or use the final destination URLs in the refs before merging.

Apply this diff:

-You can download the ISOs at these addresses:
+You can download the ISOs at these addresses:

-| System        | URL                                                                |
-| :------------ | :----------------------------------------------------------------- |
-| x86 Linux     | https://install.determinate.systems/nixos-iso/stable/x86_64-linux  |
-| aarch64 Linux | https://install.determinate.systems/nixos-iso/stable/aarch64-linux |
+| System        | URL             |
+| :------------ | :-------------- |
+| x86 Linux     | [Download][iso-x86_64]  |
+| aarch64 Linux | [Download][iso-aarch64] |

Add the link references near the other refs at the bottom:

+[iso-x86_64]: https://install.determinate.systems/nixos-iso/stable/x86_64-linux
+[iso-aarch64]: https://install.determinate.systems/nixos-iso/stable/aarch64-linux

Optionally add checksum links if available.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

38-41: Tighten wording, fix pluralization, and standardize punctuation/terminology.

Use plural “images,” reference “upstream NixOS,” add periods to list items, and use “wpa_supplicant.”

-> [!NOTE]
-> This NixOS installer image is identical to NixOS's ISOs, but with two important differences:
-> 1. Flakes are enabled by default via Determinate Nix
-> 2. NetworkManager is enabled instead of bare WPA Supplicant.
+> [!NOTE]
+> These installer images are identical to upstream NixOS ISOs, with two important differences:
+> 1. Flakes are enabled by default via Determinate Nix.
+> 2. NetworkManager is enabled instead of wpa_supplicant.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2367ad and 877c4b3.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

15-15: Bare URL used

(MD034, no-bare-urls)


16-16: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build (UbuntuLatest32Cores128G, x86_64-linux)
  • GitHub Check: build (UbuntuLatest32Cores128GArm, aarch64-linux)
🔇 Additional comments (1)
README.md (1)

11-17: Replace bare URLs with reference-style links (fixes MD034)

README.md lines 11–17 — Verified both URLs return HTTP 307 (redirect); apply this diff.

-You can download the ISOs at these addresses:
+You can download the ISOs at these addresses:

-| System        | URL                                                                |
-| :------------ | :----------------------------------------------------------------- |
-| x86 Linux     | https://install.determinate.systems/nixos-iso/stable/x86_64-linux  |
-| aarch64 Linux | https://install.determinate.systems/nixos-iso/stable/aarch64-linux |
+| System        | URL                    |
+| :------------ | :--------------------- |
+| x86 Linux     | [Stable][iso-x86]      |
+| aarch64 Linux | [Stable][iso-aarch64]  |

Add these reference links near the other reference defs:

[iso-x86]: https://install.determinate.systems/nixos-iso/stable/x86_64-linux
[iso-aarch64]: https://install.determinate.systems/nixos-iso/stable/aarch64-linux

Co-authored-by: Cole Helbling <[email protected]>
@lucperkins lucperkins requested a review from cole-h September 18, 2025 15:02
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
README.md (1)

15-15: Prior suggestion addressed.

The x86_64 Linux URL matches the earlier reviewer’s suggestion.

🧹 Nitpick comments (2)
README.md (2)

38-41: Soften “identical” claim and tighten wording/punctuation.

Avoid overstating parity and standardize periods; prefer “wpa_supplicant.”

 > [!NOTE]
-> This NixOS installer image is identical to NixOS's ISOs, but with two important differences:
-> 1. Flakes are enabled by default via Determinate Nix
-> 2. NetworkManager is enabled instead of bare WPA Supplicant.
+> This installer image is based on the upstream NixOS ISO, with these differences:
+> 1. Flakes are enabled by default via Determinate Nix.
+> 2. NetworkManager is enabled instead of wpa_supplicant.

11-17: Replace bare URLs with reference-style links (fixes MD034).

Convert the table to Markdown reference links and add the two footnote references.

 | System        | URL                                                                |
 | :------------ | :----------------------------------------------------------------- |
-| x86_64 Linux  | https://install.determinate.systems/nixos-iso/stable/x86_64-linux  |
-| aarch64 Linux | https://install.determinate.systems/nixos-iso/stable/aarch64-linux |
+| x86_64 Linux  | [stable][iso-x86_64]                                               |
+| aarch64 Linux | [stable][iso-aarch64]                                              |

Add these references to the link list at the end of the file:

+[iso-x86_64]: https://install.determinate.systems/nixos-iso/stable/x86_64-linux
+[iso-aarch64]: https://install.determinate.systems/nixos-iso/stable/aarch64-linux

Sanity-check: both endpoints returned HTTP 307 (redirect) — links are reachable.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 877c4b3 and bbb67b4.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md

15-15: Bare URL used

(MD034, no-bare-urls)


16-16: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build (UbuntuLatest32Cores128GArm, aarch64-linux)
  • GitHub Check: build (UbuntuLatest32Cores128G, x86_64-linux)

@lucperkins lucperkins merged commit cb1540a into main Sep 18, 2025
4 checks passed
@lucperkins lucperkins deleted the provide-iso-urls branch September 18, 2025 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants